Skip to content

📝 Tighten CLI README positioning#278

Merged
Robdel12 merged 1 commit into
mainfrom
rd/readme
May 25, 2026
Merged

📝 Tighten CLI README positioning#278
Robdel12 merged 1 commit into
mainfrom
rd/readme

Conversation

@Robdel12
Copy link
Copy Markdown
Contributor

Summary

  • Reframes the CLI README around Vizzly as a visual testing/regression platform instead of leading with agent context.
  • Removes the extra pitch-heavy "Why Vizzly?" section so the README gets to CLI usage faster.
  • Adds the Vizzly inspector mascot asset and includes docs assets in the npm package file list.
  • Aligns package metadata and CLI help copy with the new README framing.

Validation

  • pnpm run build
  • node bin/vizzly.js --help
  • node bin/vizzly.js context --help
  • rg -n "Visual review for agents and teams|Vizzly CLI for visual review|Fetch build context for agents and reviewers" README.md package.json src dist
  • git diff --check
  • npm --cache .tmp/npm-cache pack --dry-run

Full pnpm test was started and then intentionally skipped because this is a README/help/package metadata change.

@Robdel12 Robdel12 marked this pull request as ready for review May 25, 2026 21:24
@vizzly-testing

This comment has been minimized.

@Robdel12 Robdel12 merged commit 1735a71 into main May 25, 2026
18 checks passed
@Robdel12 Robdel12 deleted the rd/readme branch May 25, 2026 21:25
@vizzly-testing
Copy link
Copy Markdown

vizzly-testing Bot commented May 25, 2026

Vizzly - Visual Test Results

CLI Reporter - Approved

19 comparisons, no changes detected.

View build

CLI TUI - 1 change needs review
Status Count
Passed 4
Meaningful diffs 1
Auto-approved 4
Meaningful diffs needing review (1)

vizzly-help · 1202×1430 · 25.6% diff

vizzly-help

Review changes


rd/readme · 22b933c1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant